/**
 * Copyright (c) 2009/09-2012/08, Regents of the University of Colorado
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 * Copyright 2012/09-2013/04, University of Massachusetts Amherst
 * Copyright 2013/05-Present, IPSoft Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 */
package com.googlecode.clearnlp.propbank.frameset;

import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.googlecode.clearnlp.constant.universal.STConstant;

/**
 * @since 1.4.2
 * @author Jinho D. Choi ({@code jdchoi77@gmail.com})
 */
public class PBFrameset implements Serializable
{
	private static final long serialVersionUID = 3023563544488823541L;
	private Map<String,PBPredicate> m_predicates;
	private String s_lemma;

	/** @param lemma the base lemma (e.g., "run", but not "run_out"). */
	public PBFrameset(Element eFrameset, String lemma)
	{
		init();
		
		setLemma(lemma);
		addPredicates(eFrameset.getElementsByTagName(PBFLib.E_PREDICATE));
	}
	
	public void init()
	{
		m_predicates = Maps.newHashMap();
	}
	
	public void addPredicates(NodeList list)
	{
		int i, size = list.getLength();
		
		for (i=0; i<size; i++)
			addPredicate((Element)list.item(i));
	}
	
	public void addPredicate(Element element)
	{
		addPredicate(new PBPredicate(element));
	}
	
	public void addPredicate(PBPredicate predicate)
	{
		if (m_predicates.put(predicate.getLemma(), predicate) != null)
			System.err.printf("Duplicated predicate: %s\n", predicate.getLemma());
	}
	
	/** @param lemma the specific lemma of the predicate (e.g., "run_out"). */
	public PBPredicate getPredicate(String lemma)
	{
		return m_predicates.get(lemma);
	}
	
	public PBRoleset getRoleset(String rolesetID)
	{
		PBRoleset roleset;
		
		for (PBPredicate predicate : m_predicates.values())
		{
			roleset = predicate.getRoleset(rolesetID);
			
			if (roleset != null)
				return roleset;
		}
		
		return null;
	}
	
	public List<PBPredicate> getPredicateSortedList()
	{
		List<PBPredicate> list = Lists.newArrayList(m_predicates.values());
		
		Collections.sort(list);
		return list;
	}
	
	/** @return the base lemma (e.g., "run", but not "run_out"). */
	public String getLemma()
	{
		return s_lemma;
	}
	
	/** @param lemma the base lemma (e.g., "run", but not "run_out"). */
	public void setLemma(String lemma)
	{
		s_lemma = lemma;
	}
	
	public String toString()
	{
		StringBuilder build = new StringBuilder();
		
		for (PBPredicate predicate : getPredicateSortedList())
		{
			build.append(STConstant.NEW_LINE);
			build.append(predicate.toString());
		}
		
		return build.toString().trim();
	}
}
